<?php
	
	/**
	  *	This file is responsible for CMS Documentator configuration
	  *
	  *	@author Vytenis Urbonavicius <vytenis.urbonavicius@myhost.lt>
	  *	@version 0.0
	  */
	
	if ( !defined( 'SECURITY' ) ) {
		die( 'Direct access to this script is not allowed!' );
	}
	
	/**
	  *	This constant stores system root address
	  *
	  *	@name ROOT_DIR
	  */
	define( 'ROOT_DIR', str_replace( '\\', '/', dirname( __FILE__ ) ) );
	
	/**
	  *	This constant stores relative data path without pre and post slashes
	  *
	  *	@name DATA_ADDRESS
	  */
	define( 'DATA_ADDRESS', 'data' );
	
	/**
	  *	This constant defines default directory rights when creating one
	  *
	  *	@name DEFAULT_DIRECTORY_RIGHTS
	  */
	define ( 'DEFAULT_DIRECTORY_RIGHTS', 0777 );
	
	/**
	  *	This constant defines CMS Documentator version
	  *
	  *	@name VERSION
	  */
	define( 'VERSION', 0 );
	
	/**
	  *	This constant is required by CMS Documentator to confirm that it is the right packet to documentate
	  *
	  *	@name CMS_DOCUMENTATOR_HINT
	  */
	define( 'CMS_DOCUMENTATOR_HINT', 'cms_documentator_itself' );
	
	/**
	  *	This class is responsible for storing CMS Documentator configuration
	  *
	  *	@author Vytenis Urbonavicius <vytenis.urbonavicius@myhost.lt>
	  *	@version 0.0
	  */
	class CmsDocumentatorConfig {
		
		/**
		 *	This parameter stores base address of all packets
		 *
		 *	@author Vytenis Urbonavicius <vytenis.urbonavicius@myhost.lt>
		 *	@var string
		 */
		public static $base_address = 'C:/Program Files/Apache Software Foundation/Apache2.2/htdocs';
		
		/**
		 *	This parameter stores a list of packets and their configurations
		 *
		 *	@author Vytenis Urbonavicius <vytenis.urbonavicius@myhost.lt>
		 *	@var array
		 */
		public static $packets = array(
			'CMS Documentator' => array(
				'address' => 'cms_documentator',					// base address + this address = packet address
				'version_file' => 'config.php',							// file within packet directory (might be a relative address as well); must contain version constant
				'version_const' => 'VERSION',							// name of a string php constant within the version file
				'hint_file' => 'config.php',								// file within packet directory (might be a relative address as well); must contain hint constant
				'hint_const' => 'CMS_DOCUMENTATOR_HINT',	// name of a string php constant within the hint file
				'hint_value' => 'cms_documentator_itself',		// string value of a hint constant
				'show_private' => true,									// defines whether to show private methods and parameters
				'ignore_files' => array(										// list of files to be ignored
					'database.php',
				),
				'ignore_patterns' => array(								// list of patterns of file addresses for ignored addresses
					// EMPTY
				)
			),
		);
		
	}
	
?>